Skip to main content

πŸ“‡ Index

Mostly utility functions for pet system, but you can use these to get index data.

local Framework = require(path).GetServer()
local Index = Framework.Index

setIndexLevel​

Sets the level for the player, also adds more pet equip slots depending on their level!

Index.setIndexLevel(10)

getAllPets​

Gets all the pets, with the default value of false in the dictionary for each pet.

local pets = Index.getAllPets()

getUnlocked​

Returns all the pets the player has unlocked

local unlocked = Index.getUnlocked(player)

getUnlockedNum​

Returns the number of pets the player has unlocked

print(Index.getUnlockedNum(player))

addPetToIndex​

Force adds a pet to the players index, the PetModule already does this.

It also gives you a cool notification if you reach above the level requirement!

Index.addPetToIndex(player, "Cat")

getIndex​

Returns the players index

Index.getIndex(player)